What is pad-left?
The pad-left npm package is a utility that allows you to pad the left side of a string with a specified character or set of characters until the string reaches a desired length. This can be useful for formatting output, aligning text, or ensuring consistent string lengths.
What are pad-left's main functionalities?
Basic Padding
Pads the left side of the string '123' with spaces until the total length is 5.
const padLeft = require('pad-left');
const result = padLeft('123', 5);
console.log(result); // ' 123'
Custom Padding Character
Pads the left side of the string '123' with the character '0' until the total length is 5.
const padLeft = require('pad-left');
const result = padLeft('123', 5, '0');
console.log(result); // '00123'
Padding with Multiple Characters
Pads the left side of the string '123' with the string 'abc' repeated until the total length is 7.
const padLeft = require('pad-left');
const result = padLeft('123', 7, 'abc');
console.log(result); // 'abca123'
Other packages similar to pad-left
left-pad
The left-pad package provides similar functionality to pad-left, allowing you to pad the left side of a string with a specified character or set of characters. It is widely known and used in the JavaScript community.
string-pad
The string-pad package offers more comprehensive padding options, including both left and right padding. It allows for more flexibility in padding strings compared to pad-left.
pad
The pad package provides both left and right padding functionalities. It is a versatile package that can be used for various string padding needs, making it a more general-purpose tool compared to pad-left.
pad-left
Left pad a string with zeros or a specified string. Fastest implementation.
You might also be interested in word-wrap.
Install
Install with npm:
$ npm install pad-left --save
Usage
var pad = require('pad-left');
pad( '4', 4, '0')
pad( '35', 4, '0')
pad('459', 4, '0')
Benchmarks
Benchmarks for node.js v6.1.0 versus left-pad.
pad-left x 14,940,947 ops/sec ±0.81% (87 runs sampled)
left-pad x 7,901,604 ops/sec ±1.17% (86 runs sampled)
pad-left x 13,305,123 ops/sec ±1.53% (84 runs sampled)
left-pad x 6,979,536 ops/sec ±1.13% (84 runs sampled)
pad-left x 14,227,637 ops/sec ±1.41% (81 runs sampled)
left-pad x 1,352,240 ops/sec ±1.51% (86 runs sampled)
pad-left x 15,664,561 ops/sec ±0.99% (83 runs sampled)
left-pad x 1,247,316 ops/sec ±0.96% (87 runs sampled)
pad-left x 15,210,294 ops/sec ±1.15% (87 runs sampled)
left-pad x 159,958 ops/sec ±1.01% (88 runs sampled)
pad-left x 14,157,425 ops/sec ±1.10% (88 runs sampled)
left-pad x 143,805 ops/sec ±1.08% (87 runs sampled)
Benchmarks for node.js v6.1.0 versus stevemao/left-pad.
pad-left x 13,251,037 ops/sec ±1.40% (84 runs sampled)
left-pad x 10,745,530 ops/sec ±1.18% (86 runs sampled)
pad-left x 13,644,357 ops/sec ±1.33% (87 runs sampled)
left-pad x 20,107,245 ops/sec ±1.00% (88 runs sampled)
pad-left x 15,650,330 ops/sec ±1.01% (86 runs sampled)
left-pad x 9,706,877 ops/sec ±1.13% (87 runs sampled)
pad-left x 17,255,593 ops/sec ±0.99% (88 runs sampled)
left-pad x 6,312,637 ops/sec ±1.16% (87 runs sampled)
pad-left x 15,679,410 ops/sec ±0.99% (90 runs sampled)
left-pad x 6,439,580 ops/sec ±1.08% (86 runs sampled)
Related projects
You might also be interested in these projects:
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert.
Released under the MIT license.
This file was generated by verb, v0.9.0, on May 07, 2016.